<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilasu: ECC Client APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilasu
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xasu__ecc__client__apis.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">ECC Client APIs</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaaabcb4485412f47df39713bd5df6a544"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xasu__ecc__client__apis.html#gaaabcb4485412f47df39713bd5df6a544">XAsu_EccGenSign</a> (<a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *ClientParamsPtr, <a class="el" href="struct_x_asu___ecc_params.html">XAsu_EccParams</a> *EccParamsPtr)</td></tr>
<tr class="memdesc:gaaabcb4485412f47df39713bd5df6a544"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends command to ASUFW to generate an ECDSA signature for the provided hash by using the given private key associated with the elliptic curve.  <a href="#gaaabcb4485412f47df39713bd5df6a544">More...</a><br/></td></tr>
<tr class="separator:gaaabcb4485412f47df39713bd5df6a544"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4b8e73d2c2143da5c419680e6a1d6c59"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xasu__ecc__client__apis.html#ga4b8e73d2c2143da5c419680e6a1d6c59">XAsu_EccVerifySign</a> (<a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *ClientParamsPtr, <a class="el" href="struct_x_asu___ecc_params.html">XAsu_EccParams</a> *EccParamsPtr)</td></tr>
<tr class="memdesc:ga4b8e73d2c2143da5c419680e6a1d6c59"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends a command to validate the ECDSA signature for the provided hash using the provided ecc public key.  <a href="#ga4b8e73d2c2143da5c419680e6a1d6c59">More...</a><br/></td></tr>
<tr class="separator:ga4b8e73d2c2143da5c419680e6a1d6c59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga48e7b1ccb5585cef9da33497b4ddecd4"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xasu__ecc__client__apis.html#ga48e7b1ccb5585cef9da33497b4ddecd4">XAsu_EccGenPubKey</a> (<a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *ClientParamsPtr, <a class="el" href="struct_x_asu___ecc_key_params.html">XAsu_EccKeyParams</a> *EccKeyParamsPtr)</td></tr>
<tr class="memdesc:ga48e7b1ccb5585cef9da33497b4ddecd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends a command to generate public key for the specified elliptic curve using the provided private key.  <a href="#ga48e7b1ccb5585cef9da33497b4ddecd4">More...</a><br/></td></tr>
<tr class="separator:ga48e7b1ccb5585cef9da33497b4ddecd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2ec91a268acc9fe5751df06df1bcfc48"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xasu__ecc__client__apis.html#ga2ec91a268acc9fe5751df06df1bcfc48">XAsu_EccKat</a> (<a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *ClientParamsPtr)</td></tr>
<tr class="memdesc:ga2ec91a268acc9fe5751df06df1bcfc48"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends a command to perform ECC Known Answer Tests (KAT's).  <a href="#ga2ec91a268acc9fe5751df06df1bcfc48">More...</a><br/></td></tr>
<tr class="separator:ga2ec91a268acc9fe5751df06df1bcfc48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga479b14161470bf8787e6f265bb4d23d8"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xasu__ecc__client__apis.html#ga479b14161470bf8787e6f265bb4d23d8">XAsu_EcdhGenSharedSecret</a> (<a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *ClientParamsPtr, XAsu_EcdhParams *EcdhParamsPtr)</td></tr>
<tr class="memdesc:ga479b14161470bf8787e6f265bb4d23d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends a command to ASUFW, to generate an ECDH shared secret, by using the provided ECC public key and private key.  <a href="#ga479b14161470bf8787e6f265bb4d23d8">More...</a><br/></td></tr>
<tr class="separator:ga479b14161470bf8787e6f265bb4d23d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga856dd75948e7f1643841339257eade80"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xasu__ecc__client__apis.html#ga856dd75948e7f1643841339257eade80">XAsu_EcdhKat</a> (<a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *ClientParamsPtr)</td></tr>
<tr class="memdesc:ga856dd75948e7f1643841339257eade80"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends a command to ASUFW to perform ECDH Known Answer Tests (KAT's).  <a href="#ga856dd75948e7f1643841339257eade80">More...</a><br/></td></tr>
<tr class="separator:ga856dd75948e7f1643841339257eade80"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga48e7b1ccb5585cef9da33497b4ddecd4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XAsu_EccGenPubKey </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *&#160;</td>
          <td class="paramname"><em>ClientParamsPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_asu___ecc_key_params.html">XAsu_EccKeyParams</a> *&#160;</td>
          <td class="paramname"><em>EccKeyParamsPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends a command to generate public key for the specified elliptic curve using the provided private key. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ClientParamsPtr</td><td>Pointer to the <a class="el" href="struct_x_asu___client_params.html" title="This structure contains client parameters information. ">XAsu_ClientParams</a> structure which holds the client input parameters. </td></tr>
    <tr><td class="paramname">EccKeyParamsPtr</td><td>Pointer to <a class="el" href="struct_x_asu___ecc_key_params.html" title="This structure contains ECC params info for public key generation. ">XAsu_EccKeyParams</a> structure which holds the parameters of ECC input arguments.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS, if IPI request to ASU is sent successfully.</li>
<li>XASU_INVALID_ARGUMENT, if any argument is invalid.</li>
<li>XASU_QUEUE_FULL, if Queue buffer is full.</li>
<li>XST_FAILURE, if sending IPI request to ASU fails. </li>
</ul>
</dd></dl>
<p>Validate input parameters.</p>
<p>Generate a unique ID and register the callback function.</p>
<p>Create command header.</p>
<p>Update request buffer and send an IPI request to ASU. </p>

<p>References <a class="el" href="struct_x_asu___ecc_key_params.html#a0d0ce8eef9e2961c1b392c827d3caba7">XAsu_EccKeyParams::CurveType</a>, <a class="el" href="struct_x_asu___ecc_key_params.html#ad26b93b7f9470c8fc62a07f4fc954e1b">XAsu_EccKeyParams::KeyLen</a>, <a class="el" href="struct_x_asu___ecc_key_params.html#a89ea1775c2f9736d7cf50876c80b5951">XAsu_EccKeyParams::PubKeyAddr</a>, <a class="el" href="struct_x_asu___ecc_key_params.html#abccac9875207c379784d0e069ab80414">XAsu_EccKeyParams::PvtKeyAddr</a>, <a class="el" href="group__xasu__client__info.html#gad0de9c14ad7810516d9f71d5b18c44c1">XAsu_CreateHeader()</a>, <a class="el" href="group__xasu__common__defs.html#ga6ae858dda9f5299a42254dfa7c9cc73f">XASU_ECC_GEN_PUBKEY_CMD_ID</a>, <a class="el" href="group__xasu__ecies__common__apis.html#gabea090d5e90377bd531c47b85e8854bc">XAsu_EccValidateCurveInfo()</a>, <a class="el" href="group__xasu__client__info.html#gga06fc87d81c62e9abb8790b6e5713c55ba21f6a079219ddf14b57959e9a40be8b9">XASU_INVALID_ARGUMENT</a>, <a class="el" href="group__xasu__client__info.html#gga06fc87d81c62e9abb8790b6e5713c55ba2e92f55c533ae361894e1cebba98f7ed">XASU_INVALID_CURVEINFO</a>, <a class="el" href="group__xasu__client__info.html#gga06fc87d81c62e9abb8790b6e5713c55bacf18aeeb8b7146572b4eadc9780ad4cb">XASU_INVALID_UNIQUE_ID</a>, <a class="el" href="group__xasu__common__defs.html#gab1bb64b01f529f1437cdd11017cc1751">XASU_MODULE_ECC_ID</a>, <a class="el" href="group__xasu__client__info.html#ga6653ca717c2d2ed8399945c294af2f9f">XAsu_RegCallBackNGetUniqueId()</a>, <a class="el" href="group__xasu__common__defs.html#ga0e29ca164aa8fa3ac30a7b9102b615d9">XASU_UNIQUE_ID_MAX</a>, <a class="el" href="group__xasu__client__info.html#ga202195f871d91b50787438e2782be07f">XAsu_UpdateQueueBufferNSendIpi()</a>, and <a class="el" href="group__xasu__client__info.html#gae0f7072bf1eddf7ee11f1e5852570682">XAsu_ValidateClientParameters()</a>.</p>

</div>
</div>
<a class="anchor" id="gaaabcb4485412f47df39713bd5df6a544"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XAsu_EccGenSign </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *&#160;</td>
          <td class="paramname"><em>ClientParamsPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_asu___ecc_params.html">XAsu_EccParams</a> *&#160;</td>
          <td class="paramname"><em>EccParamsPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends command to ASUFW to generate an ECDSA signature for the provided hash by using the given private key associated with the elliptic curve. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ClientParamsPtr</td><td>Pointer to the <a class="el" href="struct_x_asu___client_params.html" title="This structure contains client parameters information. ">XAsu_ClientParams</a> structure which holds the client input parameters. </td></tr>
    <tr><td class="paramname">EccParamsPtr</td><td>Pointer to <a class="el" href="struct_x_asu___ecc_params.html" title="This structure contains ECC params info. ">XAsu_EccParams</a> structure which holds the parameters of ECC input arguments.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS, if IPI request to ASU is sent successfully.</li>
<li>XASU_INVALID_ARGUMENT, if any argument is invalid.</li>
<li>XASU_QUEUE_FULL, if Queue buffer is full.</li>
<li>XST_FAILURE, if sending IPI request to ASU fails. </li>
</ul>
</dd></dl>
<p>Validate input parameters.</p>
<p>Generate a unique ID and register the callback function.</p>
<p>Create command header.</p>
<p>Update request buffer and send an IPI request to ASU. </p>

<p>References <a class="el" href="group__xasu__client__info.html#gad0de9c14ad7810516d9f71d5b18c44c1">XAsu_CreateHeader()</a>, <a class="el" href="group__xasu__common__defs.html#ga549a33ccfc02a7609c2f7868db91aecd">XASU_ECC_GEN_SIGNATURE_CMD_ID</a>, <a class="el" href="group__xasu__client__info.html#gga06fc87d81c62e9abb8790b6e5713c55bacf18aeeb8b7146572b4eadc9780ad4cb">XASU_INVALID_UNIQUE_ID</a>, <a class="el" href="group__xasu__common__defs.html#gab1bb64b01f529f1437cdd11017cc1751">XASU_MODULE_ECC_ID</a>, <a class="el" href="group__xasu__client__info.html#ga6653ca717c2d2ed8399945c294af2f9f">XAsu_RegCallBackNGetUniqueId()</a>, <a class="el" href="group__xasu__common__defs.html#ga0e29ca164aa8fa3ac30a7b9102b615d9">XASU_UNIQUE_ID_MAX</a>, <a class="el" href="group__xasu__client__info.html#ga202195f871d91b50787438e2782be07f">XAsu_UpdateQueueBufferNSendIpi()</a>, and <a class="el" href="group__xasu__client__info.html#gae0f7072bf1eddf7ee11f1e5852570682">XAsu_ValidateClientParameters()</a>.</p>

</div>
</div>
<a class="anchor" id="ga2ec91a268acc9fe5751df06df1bcfc48"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XAsu_EccKat </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *&#160;</td>
          <td class="paramname"><em>ClientParamsPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends a command to perform ECC Known Answer Tests (KAT's). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ClientParamsPtr</td><td>Pointer to the <a class="el" href="struct_x_asu___client_params.html" title="This structure contains client parameters information. ">XAsu_ClientParams</a> structure which holds the client input parameters.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS, if IPI request to ASU is sent successfully.</li>
<li>XASU_INVALID_ARGUMENT, if any argument is invalid.</li>
<li>XASU_QUEUE_FULL, if Queue buffer is full.</li>
<li>XST_FAILURE, if sending IPI request to ASU fails. </li>
</ul>
</dd></dl>
<p>Validate input parameters.</p>
<p>Generate a unique ID and register the callback function.</p>
<p>Create command header.</p>
<p>Update request buffer and send an IPI request to ASU. </p>

<p>References <a class="el" href="group__xasu__client__info.html#gad0de9c14ad7810516d9f71d5b18c44c1">XAsu_CreateHeader()</a>, <a class="el" href="group__xasu__common__defs.html#ga9a001666cbead1c0995a30c81d3cf705">XASU_ECC_KAT_CMD_ID</a>, <a class="el" href="group__xasu__client__info.html#gga06fc87d81c62e9abb8790b6e5713c55bacf18aeeb8b7146572b4eadc9780ad4cb">XASU_INVALID_UNIQUE_ID</a>, <a class="el" href="group__xasu__common__defs.html#gab1bb64b01f529f1437cdd11017cc1751">XASU_MODULE_ECC_ID</a>, <a class="el" href="group__xasu__client__info.html#ga6653ca717c2d2ed8399945c294af2f9f">XAsu_RegCallBackNGetUniqueId()</a>, <a class="el" href="group__xasu__common__defs.html#ga0e29ca164aa8fa3ac30a7b9102b615d9">XASU_UNIQUE_ID_MAX</a>, <a class="el" href="group__xasu__client__info.html#ga202195f871d91b50787438e2782be07f">XAsu_UpdateQueueBufferNSendIpi()</a>, and <a class="el" href="group__xasu__client__info.html#gae0f7072bf1eddf7ee11f1e5852570682">XAsu_ValidateClientParameters()</a>.</p>

</div>
</div>
<a class="anchor" id="ga4b8e73d2c2143da5c419680e6a1d6c59"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XAsu_EccVerifySign </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *&#160;</td>
          <td class="paramname"><em>ClientParamsPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_asu___ecc_params.html">XAsu_EccParams</a> *&#160;</td>
          <td class="paramname"><em>EccParamsPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends a command to validate the ECDSA signature for the provided hash using the provided ecc public key. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ClientParamsPtr</td><td>Pointer to the <a class="el" href="struct_x_asu___client_params.html" title="This structure contains client parameters information. ">XAsu_ClientParams</a> structure which holds the client input parameters. </td></tr>
    <tr><td class="paramname">EccParamsPtr</td><td>Pointer to <a class="el" href="struct_x_asu___ecc_params.html" title="This structure contains ECC params info. ">XAsu_EccParams</a> structure which holds the parameters of ECC input arguments.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS, if IPI request to ASU is sent successfully.</li>
<li>XASU_INVALID_ARGUMENT, if any argument is invalid.</li>
<li>XASU_QUEUE_FULL, if Queue buffer is full.</li>
<li>XST_FAILURE, if sending IPI request to ASU fails. </li>
</ul>
</dd></dl>
<p>Generate a unique ID and register the callback function.</p>
<p>Create command header.</p>
<p>Update request buffer and send an IPI request to ASU. </p>

<p>References <a class="el" href="group__xasu__client__info.html#gad0de9c14ad7810516d9f71d5b18c44c1">XAsu_CreateHeader()</a>, <a class="el" href="group__xasu__common__defs.html#ga169bc6365e7267e189aef9fcf1bacf81">XASU_ECC_VERIFY_SIGNATURE_CMD_ID</a>, <a class="el" href="group__xasu__client__info.html#gga06fc87d81c62e9abb8790b6e5713c55bacf18aeeb8b7146572b4eadc9780ad4cb">XASU_INVALID_UNIQUE_ID</a>, <a class="el" href="group__xasu__common__defs.html#gab1bb64b01f529f1437cdd11017cc1751">XASU_MODULE_ECC_ID</a>, <a class="el" href="group__xasu__client__info.html#ga6653ca717c2d2ed8399945c294af2f9f">XAsu_RegCallBackNGetUniqueId()</a>, <a class="el" href="group__xasu__common__defs.html#ga0e29ca164aa8fa3ac30a7b9102b615d9">XASU_UNIQUE_ID_MAX</a>, <a class="el" href="group__xasu__client__info.html#ga202195f871d91b50787438e2782be07f">XAsu_UpdateQueueBufferNSendIpi()</a>, and <a class="el" href="group__xasu__client__info.html#gae0f7072bf1eddf7ee11f1e5852570682">XAsu_ValidateClientParameters()</a>.</p>

</div>
</div>
<a class="anchor" id="ga479b14161470bf8787e6f265bb4d23d8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XAsu_EcdhGenSharedSecret </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *&#160;</td>
          <td class="paramname"><em>ClientParamsPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XAsu_EcdhParams *&#160;</td>
          <td class="paramname"><em>EcdhParamsPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends a command to ASUFW, to generate an ECDH shared secret, by using the provided ECC public key and private key. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ClientParamsPtr</td><td>Pointer to the <a class="el" href="struct_x_asu___client_params.html" title="This structure contains client parameters information. ">XAsu_ClientParams</a> structure which holds the client input parameters </td></tr>
    <tr><td class="paramname">EcdhParamsPtr</td><td>Pointer to XAsu_EcdhParams structure which holds the parameters of ECDH input arguments.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS, if signature generated successfully</li>
<li>XASU_INVALID_ARGUMENT, if any argument is invalid</li>
<li>XASU_INVALID_UNIQUE_ID, if unique ID is invalid</li>
<li>XST_FAILURE, if send IPI fails </li>
</ul>
</dd></dl>
<p>Validate input parameters.</p>
<p>Generate a unique ID and register the callback function.</p>
<p>Create command header.</p>
<p>Update request buffer and send an IPI request to ASU. </p>

<p>References <a class="el" href="group__xasu__client__info.html#gad0de9c14ad7810516d9f71d5b18c44c1">XAsu_CreateHeader()</a>, <a class="el" href="group__xasu__ecies__common__apis.html#gabea090d5e90377bd531c47b85e8854bc">XAsu_EccValidateCurveInfo()</a>, <a class="el" href="group__xasu__common__defs.html#ga10dae1a65991613bacadcdafe44a7c79">XASU_ECDH_SHARED_SECRET_CMD_ID</a>, <a class="el" href="group__xasu__client__info.html#gga06fc87d81c62e9abb8790b6e5713c55ba21f6a079219ddf14b57959e9a40be8b9">XASU_INVALID_ARGUMENT</a>, <a class="el" href="group__xasu__client__info.html#gga06fc87d81c62e9abb8790b6e5713c55bacf18aeeb8b7146572b4eadc9780ad4cb">XASU_INVALID_UNIQUE_ID</a>, <a class="el" href="group__xasu__common__defs.html#gab1bb64b01f529f1437cdd11017cc1751">XASU_MODULE_ECC_ID</a>, <a class="el" href="group__xasu__client__info.html#ga6653ca717c2d2ed8399945c294af2f9f">XAsu_RegCallBackNGetUniqueId()</a>, <a class="el" href="group__xasu__common__defs.html#ga0e29ca164aa8fa3ac30a7b9102b615d9">XASU_UNIQUE_ID_MAX</a>, <a class="el" href="group__xasu__client__info.html#ga202195f871d91b50787438e2782be07f">XAsu_UpdateQueueBufferNSendIpi()</a>, and <a class="el" href="group__xasu__client__info.html#gae0f7072bf1eddf7ee11f1e5852570682">XAsu_ValidateClientParameters()</a>.</p>

<p>Referenced by <a class="el" href="group__xasufw__ecdh__client__example.html#ga840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="ga856dd75948e7f1643841339257eade80"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XAsu_EcdhKat </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *&#160;</td>
          <td class="paramname"><em>ClientParamsPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends a command to ASUFW to perform ECDH Known Answer Tests (KAT's). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ClientParamsPtr</td><td>Pointer to client params structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS, if ECDH Kat runs succefully</li>
<li>XASU_INVALID_UNIQUE_ID, if unique ID is invalid</li>
<li>XST_FAILURE, if send IPI fails </li>
</ul>
</dd></dl>
<p>Validate input parameters.</p>
<p>Generate a unique ID and register the callback function.</p>
<p>Create command header.</p>
<p>Update request buffer and send an IPI request to ASU. </p>

<p>References <a class="el" href="group__xasu__client__info.html#gad0de9c14ad7810516d9f71d5b18c44c1">XAsu_CreateHeader()</a>, <a class="el" href="group__xasu__common__defs.html#ga88d456387e78867dfe712550898b9f6e">XASU_ECDH_KAT_CMD_ID</a>, <a class="el" href="group__xasu__client__info.html#gga06fc87d81c62e9abb8790b6e5713c55bacf18aeeb8b7146572b4eadc9780ad4cb">XASU_INVALID_UNIQUE_ID</a>, <a class="el" href="group__xasu__common__defs.html#gab1bb64b01f529f1437cdd11017cc1751">XASU_MODULE_ECC_ID</a>, <a class="el" href="group__xasu__client__info.html#ga6653ca717c2d2ed8399945c294af2f9f">XAsu_RegCallBackNGetUniqueId()</a>, <a class="el" href="group__xasu__common__defs.html#ga0e29ca164aa8fa3ac30a7b9102b615d9">XASU_UNIQUE_ID_MAX</a>, <a class="el" href="group__xasu__client__info.html#ga202195f871d91b50787438e2782be07f">XAsu_UpdateQueueBufferNSendIpi()</a>, and <a class="el" href="group__xasu__client__info.html#gae0f7072bf1eddf7ee11f1e5852570682">XAsu_ValidateClientParameters()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
